Lua/Shared/AnimationState

Description

AnimationState is an enumeration containing valid animation states for functions such as LocalPlayer:SetUpperBodyState and LocalPlayer:SetBaseState.

Each enumeration name is prefixed with 'LaS', 'UbS', 'S' and others. These represent what kind of animation it is; for example, 'LaSAbortRecoil' is a Left arm State; likewise, 'UbSWieldingIdle' is a Upper-body State.

The following table shows the prefixes and the functions they correspond to.

Prefix	Setter	Getter	Example
S	LocalPlayer:SetBaseState	Player:GetBaseState	SSkydiveDash
UbS	LocalPlayer:SetUpperBodyState	Player:GetUpperBodyState	UbSWieldingIdle
LaS	LocalPlayer:SetLeftArmState	Player:GetLeftArmState	LaSAbortRecoil
Pcs	N/A	N/A	PcsOpen

If you use the wrong type of state with a function, nothing will happen.

Statics

Name	Value
LaSAbortRecoil	481
LaSAiming	392
LaSBeaconAim	395
LaSBeaconEquip	396
LaSBeaconUnequip	397
LaSDropWeapon	473
LaSDualGrapple	404
LaSDualGrappleReturn	405
LaSEquipGrenade	385
LaSGrapple	399
LaSGrappleDetach	401
LaSGrapplePull	398
LaSGrappleReelIn	410
LaSGrappleReelOut	409
LaSGrappleToIdle	400
LaSGrenadeWait	454
LaSHookHit	408
LaSHookMissed	407
LaSIdle	384
LaSOverThrowGrenade	388
LaSPlaceExplosives	390
LaSPlaceTriggeredExplosive	389
LaSRaiseGrapple	402
LaSRaiseGrappleSo	403
LaSRecoilFinishedLh	480
LaSRecoilLh	479
LaSReload	394
LaSThrowGrenade	478
LaSThrowTriggeredExplosive	391
LaSThrowTriggeredExplosiveAi	453
LaSTriggerBoom	452
LaSUnderThrowGrenade	387
LaSWaitingForHook	406
LaSWieldGrenade	386
LaSWielding	393
PcsClosed	2
PcsClosing	5
PcsOpen	1
PcsOpeningHorizontal	4
PcsOpeningVertical	3
RaSIdle	383
SAiBasicNavigation	259
SAiUprightStrafe	258
SAiUprightStrafeBackward	447
SAiUprightStrafeForward	443
SAiUprightStrafeLeft	444
SAiUprightStrafeRight	446
SAimMg	193
SAirborneRagdoll	253
SAnnoyed	482
SBabyStunned	445
SBellyToFall	425
SBellyToSkydive	423
SBlendToSwimIdle	135
SCartwheel	320
SCartwheelInterupt	322
SCivSoAnnoyed	483
SCivSoEnter	342
SCivSoExclamation	345
SCivSoExit	344
SCivSoIdle	343
SClimbDownFromMg	206
SClimbIntoMgPt1	203
SClimbIntoMgPt2	204
SClimbLadderDown	130
SClimbLadderIdle	128
SClimbLadderIdleAtBottom	126
SClimbLadderIdleAtTop	127
SClimbLadderStarting	125
SClimbLadderUp	129
SClimbOutofMgPt1	432
SClimbOutofMgPt2	205
SClimbUpIntoMg	202
SClingDownToIdlePart1	102
SClingDownToIdlePart2	103
SClingDownToLeftPart1	96
SClingDownToRightPart1	97
SClingLeanDown	87
SClingLeanLeft	86
SClingLeanRight	85
SClingLeftToDownPart1	94
SClingLeftToIdlePart1	100
SClingLeftToIdlePart2	101
SClingLeftToRight	92
SClingLftToRoof	106
SClingLftToRoofInterupt	107
SClingMidToDownPart1	91
SClingMidToLeftPart1	90
SClingMidToRightPart1	89
SClingMidToRoof	104
SClingMidToRoofInterupt	105
SClingRgtToRoof	108
SClingRgtToRoofInterupt	109
SClingRightToDownPart1	95
SClingRightToIdlePart1	98
SClingRightToIdlePart2	99
SClingRightToLeft	93
SClingStuntpositionIdle	84
SClingToNeutral	456
SClingToRoof	318
SClingToUnfoldparachute	462
SCloseCombatKick	311
SCloseCombatRunningKick	312
SCloseLeftDoorFromInside	59
SCloseRightDoorFromInside	62
SCoverEntering	168
SCoverEnteringAttack	169
SCoverHead	340
SCoverHeadEnter	339
SCoverHidden	170
SCoverHiding	179
SCoverHidingLeft	171
SCoverHidingRight	175
SCoverIdleAttack	180
SCoverIdleAttackLeft	172
SCoverIdleAttackRight	176
SCoverLeaving	183
SCoverUnhiding	181
SCoverUnhidingAim	182
SCoverUnhidingLeft	173
SCoverUnhidingLeftAim	174
SCoverUnhidingRight	177
SCoverUnhidingRightAim	178
SCrouch	15
SCrouchWalk	18
SCrouching	338
SCustomTimeVariableTeleportState	276
SDash	19
SDashStop	458
SDashTurn180	20
SDead	56
SDefaultStuntpositionIdle	88
SDefaultStuntpositionRotate180Ccw	152
SDefaultStuntpositionRotate180Cw	151
SDefaultStuntpositionRotate90Ccw	461
SDefaultStuntpositionRotate90Cw	459
SDefaultToNeutral	327
SDiveFromBoat	341
SDownToCrouch	16
SDriverHideInVehicle	79
SDriverToNeutral	330
SDriverToPassenger	77
SDriverToVictim	263
SDying	55
SDyingAirbound	51
SDyingBlendin	54
SDyingPosematching	52
SDyingPosematchingNonfancy	53
SEjectFromVehicleAlive	334
SEjectFromVehicleDead	333
SEnterFmg	434
SEnterMc	115
SEnterMg	200
SEnterMgWithMg	201
SEnterOccupiedMcPt1	117
SEnterOccupiedMcPt2	118
SEnterOccupiedMcStart	116
SEnteringVehicle	64
SEnteringVehicleRight	70
SEvade	21
SEvadeInterrupt	22
SExitFmg	426
SExitMg	439
SExitMgWithMg	421
SExitStuntposition	464
SExitingVehicle	66
SExitingVehicleFromHide	65
SExitingVehicleGameVelocity	68
SExitingVehicleGameVelocityInterrupt	69
SExitingVehicleInterupt	67
SExitingVehicleRight	71
SFall	34
SFallMg	440
SFallToSkydive	323
SFromSkydiveDash	190
SGrappleSmashLeft	296
SGrappleSmashRight	295
SGrappled	291
SGroundToNeutral	111
SHangFireHook	223
SHangToFall	215
SHanged	57
SHangstuntIdle	110
SHijackEnterRight	226
SHijackEnterRightFromHide	230
SHijackExitRight	224
SHijackHideRight	227
SHijackHideTransitionRight	228
SHijackShootRight	225
SHijackShootTransitionRight	229
SHijackStumbleBackward	232
SHijackStumbleForward	231
SHitByGrapplinghook	290
SHitreactGetUp	257
SHitreactGetUpBlendin	256
SHitreactStumbleBackward	236
SHitreactStumbleBackwardPart2	237
SHitreactStumbleBackwardSplitter	463
SHitreactStumbleForward	234
SHitreactStumbleForwardPart2	235
SHitreactStumbleHead	246
SHitreactStumbleHeadPart2	247
SHitreactStumbleLeft	238
SHitreactStumbleLeftLeg	242
SHitreactStumbleLeftLegPart2	243
SHitreactStumbleLeftPart2	239
SHitreactStumbleRandomized	233
SHitreactStumbleRight	240
SHitreactStumbleRightLeg	244
SHitreactStumbleRightLegPart2	245
SHitreactStumbleRightPart2	241
SHitreactStumbleShake	248
SHitreactStumbleShakeEnd	249
SHitreactUncontrolledFlight	250
SHitreactUncontrolledFlightPosematching	251
SIdleFixedMg	196
SIdleFmg	199
SIdleMg	194
SIdlePassengerVehicle	75
SIdleVehicle	73
SIdleVehicleMg	195
SInstantDash	184
SJumpFallingToSkydive	167
SJumpFlightSprintForward	30
SJumpFlightStanding	29
SJumpFromSoFlightA	261
SJumpFromSoFlightB	262
SJumpFromSoLand	466
SJumpFromSoStart	260
SJumpLand	315
SJumpLandHeavy	166
SJumpLandIdle	31
SJumpLandInterrupt	316
SJumpLandSprintForward	32
SJumpLandSprintForwardStop	33
SJumpRuningLand	314
SJumpRunningLand	186
SJumpRunningLandInterrupt	317
SJumpStartSprintForward	27
SJumpStartStanding	26
SJumpToFall	148
SJumpToFallTransition	28
SJumpToSkydive	188
SJumpToSkysuit	147
SLadderClimbDown	304
SLadderClimbDownLoop	305
SLadderClimbUp	302
SLadderClimbUpLoop	303
SLadderDropToFall	310
SLadderDropToSkydive	309
SLadderEnterAtTop	133
SLadderEnterBottom	298
SLadderEnterTop	297
SLadderExitAtTop	132
SLadderExitBottom	300
SLadderExitTop	299
SLadderIdle	301
SLadderJumpDown	131
SLadderJumpToLadder	308
SLadderParachuteToLadder	306
SLadderReelToLadder	307
SLand	35
SLandFast	37
SLandHard	36
SLandingHard	422
SLandingMg	424
SLandingRoll	428
SLessUncontrolledSkydive	255
SLiftMcFinish	332
SLiftMcStart	331
SMgAimToIdle	197
SMgIdleToAim	198
SNeutralToDefault	112
SNeutralToDefaultInterupt	329
SNeutralToDriver	328
SNeutralToMcDriver	465
SNeutralToStruggle	289
SNpcTacticalNavigation	475
SOpenLeftDoorFromInside	60
SOpenLeftDoorFromOutside	58
SOpenRightDoorFromInside	63
SOpenRightDoorFromOutside	61
SPanicExitVehicleMg	433
SParachute	45
SParachuteDetachToFreefall	47
SParachuteFromDriver	44
SParachuteLandFast	49
SParachuteLandSlow	48
SParachuteLanding	46
SParachuteToSoLand	50
SParachuteToSoStart	468
SParachuteUnfolding	40
SParachuteUnfoldingGhost	438
SPassHideInVehicle	78
SPassengerToDriver	76
SPerformingStunt	158
SPickup	187
SPlayingCustomAnimation	121
SPlayingCustomAnimationCrouched	123
SPlayingUninterruptableCustomAnimation	122
SPlayingUninterruptableCustomAnimationCrouched	124
SPlunge	25
SPullInAirFlight	455
SPullOpenParachuteVertical	43
SReelEndLand	216
SReelFlight	208
SReelImpact	415
SReelImpactHorizontal	211
SReelImpactHorizontalEnd	474
SReelImpactVertical	209
SReelImpactVerticalInterrupt	210
SReelInToArveTeleport	427
SReelStart	207
SReelToSo	324
SReelToSoImpact	221
SReelToSoLand	325
SReeledFireHook	219
SReeledInIdle	212
SReeledInIdleEnd	414
SReeledInJump	213
SReeledInRelease	217
SReeledInReleaseDrop	214
SReeledInSpinjump	326
SReeledInToFall	429
SReeledInToHang	222
SReeledReleaseToFall	218
SReeledToSkydive	418
SReeledWaitForHook	220
SRemoveGrapplinghook	294
SReverseMc	120
SRidingMc	119
SRocketBabyIdle	14
SRollLeft	23
SRollOutLeft	153
SRollRight	24
SRoofToCling	319
SRoofToClingInterupt	321
SRunStrafeLeftTurn	160
SRunStrafeLeftTurnInterrupt	162
SRunStrafeRightTurn	161
SRunStrafeRightTurnInterrupt	163
SSideJumpPart1	335
SSideJumpPart2	336
SSidestep	313
SSkydive	38
SSkydiveDash	191
SSkydivePullchord	39
SStepBackward	13
SStrafeStopCcw	165
SStrafeStopCw	164
SStruggleAttack1	284
SStruggleAttack2	285
SStruggleAttack3	286
SStruggleAttack4	287
SStruggleCountered	278
SStruggleHitreact	288
SStruggleIdle	277
SStruggleMiss1	279
SStruggleMiss2	280
SStruggleMiss3	281
SStruggleMiss4	282
SStruggleThrowOut	283
SStruggleToNeutral	430
SStumble	337
SStuntFall	159
SStuntJumpFlight	82
SStuntJumpLand	83
SStuntJumpStart	81
SStuntJumping	80
SStuntReelFlight	275
SSuperStuntJumpFlight	272
SSuperStuntJumpLand	273
SSuperStuntJumpLandInterupt	274
SSuperStuntJumpLandMc	457
SSuperStuntJumpLandMg	467
SSuperStuntJumpStart	270
SSuperStuntJumpStartMg	460
SSuperStuntJumpStartSwim	271
SSwimDie	139
SSwimDiveDie	146
SSwimDiveIdle	142
SSwimDiveNavigation	143
SSwimDiveRotateCcw	145
SSwimDiveRotateCw	144
SSwimIdle	134
SSwimNavigation	136
SSwimRotateCcw	138
SSwimRotateCw	137
SSwimRunToSwim	140
SSwimSubmerge	141
SSwimSwimToRun	417
SSwitchDrivingDirection	74
SSwitchingSeatToDriver	72
SToSkydiveDash	189
STurningLeft	149
STurningRight	150
SUncontrolledFlightProtect	252
SUncontrolledSkydive	254
SUnfoldParachuteHorizontal	41
SUnfoldParachuteVertical	42
SUpFromCrouch	17
SUprightBasicNavigation	7
SUprightGrappledRotateCcw	293
SUprightGrappledRotateCw	292
SUprightIdle	6
SUprightIdleVaried	185
SUprightRotateCcw	155
SUprightRotateCcwInterupt	157
SUprightRotateCw	154
SUprightRotateCwInterupt	156
SUprightSprintForwardStop	11
SUprightStart	10
SUprightStop	9
SUprightStrafe	12
SUprightTurn180	8
SUprightVehicleFromBottom	114
SUprightVehicleFromTop	113
SVictimAttack	413
SVictimBlock1	416
SVictimBlock2	435
SVictimBlock3	420
SVictimBlock4	419
SVictimCounterAttack	436
SVictimHitreact1	431
SVictimHitreact2	442
SVictimHitreact3	441
SVictimHitreact4	412
SVictimIdle	269
SVictimPulledOut	437
SVictimThrownOutFlight	268
SVictimThrownOutStart	264
SVictimThrownOutStartAtv	267
SVictimThrownOutStartPt1	265
SVictimThrownOutStartPt2	266
SWalk	411
SWalkMg	192
UbS2hIk	451
UbSAiAimIn	470
UbSAiAimOut	469
UbSAiming	347
UbSAltRecoilFinishedRh	476
UbSAltRecoilRh	477
UbSAlternativeAiming	348
UbSCloseCombat	358
UbSCombatantSo	382
UbSDash	356
UbSFall	472
UbSFireing	349
UbSGrappled	448
UbSIdle	346
UbSJumpLand	378
UbSJumpLandInterrupt	380
UbSJumpLandRun	379
UbSJumpLandRunInterrupt	381
UbSJumpStart	376
UbSJumpToFall	377
UbSReactHitLight	359
UbSReloadRh	371
UbSReloadSecondaryEnd	374
UbSReloadSecondaryLoop	372
UbSReloadSecondaryStart	373
UbSReloading	350
UbSRemoveGrapplinghook	449
UbSStartReaction	375
UbSThrowGrenade	360
UbSThrowGrenadeAim	362
UbSThrowGrenadeWield	361
UbSUnwielding	357
UbSWieldWaitLa	352
UbSWieldWaitMb	351
UbSWieldingChangeWeaponPart1	365
UbSWieldingChangeWeaponPart2	450
UbSWieldingChangeWeaponSecondary	471
UbSWieldingDown	364
UbSWieldingIdle	353
UbSWieldingNavigation	354
UbSWieldingStop	355
UbSWieldingUp	363
UbVirtualSAimHig	366
UbVirtualSAimLow	368
UbVirtualSAimMid	367
UbVirtualSFireingAdditive	369
UbVirtualSFireingOffhandAdditive	370